Get List Items

Route

/v2/lists/{id}/items

Description

Retrieve items from a specific list with pagination support. This endpoint allows you to fetch all items in a list or search for specific items.

Method

GET

Inputs

Parameter	Type	Required	Description
id	string	Yes	The unique identifier of the list
page_size	integer	No	Number of items to return (max 1000, default 100)
page_id	string	No	Page ID for pagination
search	string	No	Search term to filter items
sort_by	string	No	Field to sort by (value, created_at, updated_at)
sort_order	string	No	Sort order (asc, desc)

Query Parameters

GET /v2/lists/list-123/items?page_size=50&search=example&sort_by=value&sort_order=asc

Output

Field	Type	Description
list_id	string	List identifier
resources	array[ListItem]	Array of list item objects
size	integer	Number of items returned
next_page_id	string	Token for next page
total_count	integer	Total number of items in list
errors	array[Error]	Any errors encountered

List Item Object

Field	Type	Description
id	string	Unique item identifier
value	string	Item value
description	string	Item description
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)
metadata	object	Additional item metadata

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "list_id": "list-123",
  "resources": [
    {
      "id": "item-456",
      "value": "example@company.com",
      "description": "Executive email address",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "metadata": {
        "category": "executive",
        "priority": "high"
      }
    },
    {
      "id": "item-789",
      "value": "192.168.1.100",
      "description": "Server IP address",
      "created_at": "2024-01-14T15:45:00Z",
      "updated_at": "2024-01-14T15:45:00Z",
      "metadata": {
        "category": "infrastructure",
        "priority": "medium"
      }
    }
  ],
  "size": 2,
  "next_page_id": "next_token_jkl012",
  "total_count": 150,
  "errors": []
}

Error Response

{
  "list_id": "list-123",
  "resources": [],
  "size": 0,
  "errors": [
    {
      "code": 404,
      "message": "List not found"
    }
  ]
}